FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.us.medmorph#current (31 ms)

Package hl7.fhir.us.medmorph
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/medmorph/https://build.fhir.org/ig/HL7/fhir-medmorph/OperationDefinition-Bundle-de-identify.html
Url http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-de-identify
Version 1.0.0
Status draft
Date 2020-11-19T21:48:56+10:00
Name BundleDeIdentify
Title Generate De-Identified Bundle
Experimental False
Realm us
Authority hl7
Description Generates a de-identified bundle taking an instance of a Bundle containing PHI/PII data. The de-identification algorithm to be used is left to the implementers of the operation. Errors during the execution of the operation can be returned as OperationOutcome per the FHIR spec as a return parameter.
Type true
Kind operation

Resources that use this resource

CapabilityStatement
medmorph-healthdata-exchange-app-client Health Data Exchange App (HDEA) Client Application - (MedMorph backend services app)
medmorph-trust-service-provider Trust Service Provider

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

URL: [base]/Bundle/$deidentify

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INinputBundle1..1Bundle

An input bundle instance that needs to be de-identified

INcontext0..1string

A context value for the operation. This could be used for providing salt values, program names etc.

OUTreturn0..1Bundle

Upon successful de-identification, the de-identified bundle is returned back from the service.


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "Bundle-de-identify",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Bundle/$deidentify</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>inputBundle</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>An input bundle instance that needs to be de-identified</p>\n</div></td></tr><tr><td>IN</td><td>context</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A context value for the operation. This could be used for providing salt values, program names etc.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Upon successful de-identification, the de-identified bundle is returned back from the service.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://hl7.org/fhir/us/medmorph/OperationDefinition/Bundle-de-identify",
  "version" : "1.0.0",
  "name" : "BundleDeIdentify",
  "title" : "Generate De-Identified Bundle",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2020-11-19T21:48:56+10:00",
  "publisher" : "HL7 International - Public Health Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "Generates a de-identified bundle taking an instance of a Bundle containing PHI/PII data. The de-identification algorithm to be used is left to the implementers of the operation. Errors during the execution of the operation can be returned as OperationOutcome per the FHIR spec as a return parameter.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "deidentify",
  "resource" : [
    "Bundle"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "inputBundle",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "An input bundle instance that needs to be de-identified",
      "type" : "Bundle"
    },
    {
      "name" : "context",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A context value for the operation. This could be used for providing salt values, program names etc.",
      "type" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Upon successful de-identification, the de-identified bundle is returned back from the service.",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.